<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>D:/Program Files/Vim/vimfiles/bundle/vimwiki/doc/vimwiki.txt.html</title>
<meta name="Generator" content="Vim/7.4">
<meta name="plugin-version" content="vim7.4_v1">
<meta name="syntax" content="help">
<meta name="settings" content="use_css,pre_wrap,no_foldcolumn,expand_tabs,prevent_copy=">
<meta name="colorscheme" content="molokai">
<style type="text/css">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #f8f8f2; background-color: #1b1d1e; }
body { font-family: monospace; color: #f8f8f2; background-color: #1b1d1e; }
* { font-size: 1em; }
.Identifier { color: #fd971f; }
.Special { color: #66d9ef; background-color: #1b1d1e; padding-bottom: 1px; font-style: italic; }
.PreProc { color: #a6e22e; }
.Todo { color: #ffffff; background-color: #1b1d1e; padding-bottom: 1px; font-weight: bold; }
.Statement { color: #f92672; font-weight: bold; }
.Type { color: #66d9ef; }
.Comment { color: #465457; }
.String { color: #e6db74; }
-->
</style>

<script type='text/javascript'>
<!--

-->
</script>
</head>
<body>
<pre id='vimCodeElement'>
<span class="String">vimwiki.txt</span>   A Personal Wiki for Vim

             <span class="PreProc">__   __  ___   __   __  _     _  ___   ___   _  ___            </span>
            <span class="PreProc">|  | |  ||   | |  |_|  || | _ | ||   | |   | | ||   |           </span>
            <span class="PreProc">|  |_|  ||   | |       || || || ||   | |   |_| ||   |           </span>
            <span class="PreProc">|       ||   | |       ||       ||   | |      _||   |           </span>
            <span class="PreProc">|       ||   | |       ||       ||   | |     |_ |   |           </span>
             <span class="PreProc">|     | |   | | ||_|| ||   _   ||   | |    _  ||   |           </span>
              <span class="PreProc">|___|  |___| |_|   |_||__| |__||___| |___| |_||___|           </span>


                               Version: 2.1

<span class="PreProc">==============================================================================</span>
<span class="Statement">CONTENTS                                                    </span><span class="String">vimwiki-contents</span>

    1. Intro                         <span class="Identifier">vimwiki</span>
    2. Prerequisites                 <span class="Identifier">vimwiki-prerequisites</span>
    3. Mappings                      <span class="Identifier">vimwiki-mappings</span>
        3.1. Global mappings         <span class="Identifier">vimwiki-global-mappings</span>
        3.2. Local mappings          <span class="Identifier">vimwiki-local-mappings</span>
        3.3. Text objects            <span class="Identifier">vimwiki-text-objects</span>
    4. Commands                      <span class="Identifier">vimwiki-commands</span>
        4.1. Global commands         <span class="Identifier">vimwiki-global-commands</span>
        4.2. Local commands          <span class="Identifier">vimwiki-local-commands</span>
    5. Wiki syntax                   <span class="Identifier">vimwiki-syntax</span>
        5.1. Typefaces               <span class="Identifier">vimwiki-syntax-typefaces</span>
        5.2. Links                   <span class="Identifier">vimwiki-syntax-links</span>
        5.3. Headers                 <span class="Identifier">vimwiki-syntax-headers</span>
        5.4. Paragraphs              <span class="Identifier">vimwiki-syntax-paragraphs</span>
        5.5. Lists                   <span class="Identifier">vimwiki-syntax-lists</span>
        5.6. Tables                  <span class="Identifier">vimwiki-syntax-tables</span>
        5.7. Preformatted text       <span class="Identifier">vimwiki-syntax-preformatted</span>
        5.8. Mathematical formulae   <span class="Identifier">vimwiki-syntax-math</span>
        5.9. Blockquotes             <span class="Identifier">vimwiki-syntax-blockquotes</span>
        5.10. Comments               <span class="Identifier">vimwiki-syntax-comments</span>
        5.11. Horizontal line        <span class="Identifier">vimwiki-syntax-hr</span>
        5.12. Schemes                <span class="Identifier">vimwiki-syntax-schemes</span>
        5.13. Transclusions          <span class="Identifier">vimwiki-syntax-transclude</span>
        5.14. Thumbnails             <span class="Identifier">vimwiki-syntax-thumbnails</span>
    6. Folding/Outline               <span class="Identifier">vimwiki-folding</span>
    7. Placeholders                  <span class="Identifier">vimwiki-placeholders</span>
    8. Todo lists                    <span class="Identifier">vimwiki-todo-lists</span>
    9. Tables                        <span class="Identifier">vimwiki-tables</span>
    10. Diary                        <span class="Identifier">vimwiki-diary</span>
    11. Options                      <span class="Identifier">vimwiki-options</span>
        11.1. Registered Wiki        <span class="Identifier">vimwiki-register-wiki</span>
        11.2. Temporary Wiki         <span class="Identifier">vimwiki-temporary-wiki</span>
        11.3. Per-Wiki Options       <span class="Identifier">vimwiki-local-options</span>
        11.4. Global Options         <span class="Identifier">viwmiki-global-options</span>
    12. Help                         <span class="Identifier">vimwiki-help</span>
    13. Developers                   <span class="Identifier">vimwiki-developers</span>
    14. Changelog                    <span class="Identifier">vimwiki-changelog</span>
    15. License                      <span class="Identifier">vimwiki-license</span>


<span class="PreProc">==============================================================================</span>
1. Intro                                                             <span class="String">vimwiki</span>

Vimwiki is a personal wiki for Vim -- a number of linked text files that have
their own syntax highlighting.

With vimwiki you can:
    - organize notes and ideas;
    - manage todo-lists;
    - write documentation.

To do a quick start press <span class="Special">&lt;Leader&gt;</span>ww (this is usually \ww) to go to your index
wiki file.  By default it is located in:
<span class="Comment">    ~/vimwiki/index.wiki</span>

Feed it with the following example:

= My knowledge base =
<span class="Statement">    </span>* Tasks -- things to be done _yesterday_!!!
<span class="Statement">    </span>* Project Gutenberg -- good books are power.
<span class="Statement">    </span>* Scratchpad -- various temporary stuff.

Place your cursor on 'Tasks' and press Enter to create a link.  Once pressed,
'Tasks' will become '[[Tasks]]' -- a vimwiki link.  Press Enter again to
open it.  Edit the file, save it, and then press Backspace to jump back to your
index.

A vimwiki link can be constructed from more than one word.  Just visually
select the words to be linked and press Enter.  Try it with 'Project
Gutenberg'.  The result should look something like:

= My knowledge base =
<span class="Statement">    </span>* [[Tasks]] -- things to be done _yesterday_!!!
<span class="Statement">    </span>* [[Project Gutenberg]] -- good books are power.
<span class="Statement">    </span>* Scratchpad -- various temporary stuff.

<span class="PreProc">==============================================================================</span>
2. Prerequisites                                       <span class="String">vimwiki-prerequisites</span>

Make sure you have these settings in your vimrc file:
<span class="Comment">    set nocompatible</span>
<span class="Comment">    filetype plugin on</span>
<span class="Comment">    syntax on</span>

Without them Vimwiki will not work properly.


<span class="PreProc">==============================================================================</span>
3. Mappings                                                 <span class="String">vimwiki-mappings</span>

There are global and local mappings in vimwiki.

<span class="PreProc">------------------------------------------------------------------------------</span>
3.1. Global mappings                                 <span class="String">vimwiki-global-mappings</span>

<span class="Special">[count]&lt;Leader&gt;</span>ww or <span class="Special">&lt;Plug&gt;</span>VimwikiIndex
        Open index file of the <span class="Special">[count]</span>'s wiki.

        <span class="Special">&lt;Leader&gt;</span>ww opens the first wiki from <span class="Identifier">g:vimwiki_list</span>.
        1<span class="Special">&lt;Leader&gt;</span>ww as above, opens the first wiki from <span class="Identifier">g:vimwiki_list</span>.
        2<span class="Special">&lt;Leader&gt;</span>ww opens the second wiki from <span class="Identifier">g:vimwiki_list</span>.
        3<span class="Special">&lt;Leader&gt;</span>ww opens the third wiki from <span class="Identifier">g:vimwiki_list</span>.
        etc.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;w &lt;Plug&gt;VimwikiIndex</span>

See also <span class="Identifier">:VimwikiIndex</span>


<span class="Special">[count]&lt;Leader&gt;</span>wt or <span class="Special">&lt;Plug&gt;</span>VimwikiTabIndex
        Open index file of the <span class="Special">[count]</span>'s wiki in a new tab.

        <span class="Special">&lt;Leader&gt;</span>wt tabopens the first wiki from <span class="Identifier">g:vimwiki_list</span>.
        1<span class="Special">&lt;Leader&gt;</span>wt as above tabopens the first wiki from <span class="Identifier">g:vimwiki_list</span>.
        2<span class="Special">&lt;Leader&gt;</span>wt tabopens the second wiki from <span class="Identifier">g:vimwiki_list</span>.
        3<span class="Special">&lt;Leader&gt;</span>wt tabopens the third wiki from <span class="Identifier">g:vimwiki_list</span>.
        etc.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;t &lt;Plug&gt;VimwikiTabIndex</span>

See also <span class="Identifier">:VimwikiTabIndex</span>


<span class="Special">&lt;Leader&gt;</span>ws or <span class="Special">&lt;Plug&gt;</span>VimwikiUISelect
        List and select available wikies.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;wq &lt;Plug&gt;VimwikiUISelect</span>

See also <span class="Identifier">:VimwikiUISelect</span>


<span class="Special">[count]&lt;Leader&gt;</span>wi or <span class="Special">&lt;Plug&gt;</span>VimwikiDiaryIndex
        Open diary index file of the <span class="Special">[count]</span>'s wiki.

        <span class="Special">&lt;Leader&gt;</span>wi opens diary index file of the first wiki from
        <span class="Identifier">g:vimwiki_list</span>.
        1<span class="Special">&lt;Leader&gt;</span>wi the same as above.
        2<span class="Special">&lt;Leader&gt;</span>wi opens diary index file of the second wiki from
        <span class="Identifier">g:vimwiki_list</span>.
        etc.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;i &lt;Plug&gt;VimwikiDiaryIndex</span>

See also <span class="Identifier">:VimwikiDiaryIndex</span>


<span class="Special">[count]&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w or <span class="Special">&lt;Plug&gt;</span>VimwikiMakeDiaryNote
        Open diary wiki-file for today of the <span class="Special">[count]</span>'s wiki.

        <span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w opens diary wiki-file for today in the first wiki
        from <span class="Identifier">g:vimwiki_list</span>.
        1<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w as above opens diary wiki-file for today in the
        first wiki from <span class="Identifier">g:vimwiki_list</span>.
        2<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w opens diary wiki-file for today in the second wiki
        from <span class="Identifier">g:vimwiki_list</span>.
        3<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w opens diary wiki-file for today in the third wiki
        from <span class="Identifier">g:vimwiki_list</span>.
        etc.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;d &lt;Plug&gt;VimwikiMakeDiaryNote</span>

See also <span class="Identifier">:VimwikiMakeDiaryNote</span>


<span class="Special">[count]&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>t or <span class="Special">&lt;Plug&gt;</span>VimwikiTabMakeDiaryNote
        Open diary wiki-file for today of the <span class="Special">[count]</span>'s wiki in a new tab.

        <span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>t tabopens diary wiki-file for today in the first
        wiki from <span class="Identifier">g:vimwiki_list</span>.
        1<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>t as above tabopens diary wiki-file for today in the
        first wiki from <span class="Identifier">g:vimwiki_list</span>.
        2<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>t tabopens diary wiki-file for today in the second
        wiki from <span class="Identifier">g:vimwiki_list</span>.
        3<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>t tabopens diary wiki-file for today in the third
        wiki from <span class="Identifier">g:vimwiki_list</span>.
        etc.
        To remap:
<span class="Comment">        :nmap &lt;Leader&gt;dt &lt;Plug&gt;VimwikiTabMakeDiaryNote</span>

See also <span class="Identifier">:VimwikiTabMakeDiaryNote</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
3.2. Local mappings

<span class="Statement">NORMAL MODE                                           </span><span class="String">vimwiki-local-mappings</span>
<span class="Statement">                        </span><span class="String">vimwiki_&lt;Leader&gt;wh</span>
<span class="Special">&lt;Leader&gt;</span>wh              Convert current wiki page to HTML.
                        Maps to <span class="Identifier">:Vimwiki2HTML</span>
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wc &lt;Plug&gt;Vimwiki2HTML</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Leader&gt;whh</span>
<span class="Special">&lt;Leader&gt;</span>whh             Convert current wiki page to HTML and open it in
                        webbrowser.
                        Maps to <span class="Identifier">:Vimwiki2HTML</span>
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wcc &lt;Plug&gt;Vimwiki2HTMLBrowse</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Leader&gt;w&lt;Leader&gt;i</span>
<span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>i      Update diary section (delete old, insert new)
                        Only works from the diary index.
                        Maps to <span class="Identifier">:VimwikiDiaryGenerateLinks</span>
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wcr &lt;Plug&gt;VimwikiDiaryGenerateLinks</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;CR&gt;</span>
<span class="Special">&lt;CR&gt;</span>                    Follow/create wiki link (create target wiki page if
                        needed).
                        Maps to <span class="Identifier">:VimwikiFollowLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wf &lt;Plug&gt;VimwikiFollowLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;S-CR&gt;</span>
<span class="Special">&lt;S-CR&gt;</span>                  Split and follow (create target wiki page if needed).
                        May not work in some terminals. Remapping could help.
                        Maps to <span class="Identifier">:VimwikiSplitLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;we &lt;Plug&gt;VimwikiSplitLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;C-CR&gt;</span>
<span class="Special">&lt;C-CR&gt;</span>                  Vertical split and follow (create target wiki page if
                        needed).
                        May not work in some terminals. Remapping could help.
                        Maps to <span class="Identifier">:VimwikiVSplitLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wq &lt;Plug&gt;VimwikiVSplitLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;C-S-CR&gt;</span>    <span class="String">vimwiki_&lt;D-CR&gt;</span>
<span class="Special">&lt;C-S-CR&gt;</span>, <span class="Special">&lt;D-CR&gt;</span>        Follow wiki link (create target wiki page if needed),
                        opening in a new tab.
                        May not work in some terminals. Remapping could help.
                        Maps to <span class="Identifier">:VimwikiTabnewLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wt &lt;Plug&gt;VimwikiTabnewLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Backspace&gt;</span>
<span class="Special">&lt;Backspace&gt;</span>             Go back to previous wiki page.
                        Maps to <span class="Identifier">:VimwikiGoBackLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wb &lt;Plug&gt;VimwikiGoBackLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Tab&gt;</span>
<span class="Special">&lt;Tab&gt;</span>                   Find next link on the current page.
                        Maps to <span class="Identifier">:VimwikiNextLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wn &lt;Plug&gt;VimwikiNextLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;S-Tab&gt;</span>
<span class="Special">&lt;S-Tab&gt;</span>                 Find previous link on the current page.
                        Maps to <span class="Identifier">:VimwikiPrevLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wp &lt;Plug&gt;VimwikiPrevLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Leader&gt;wd</span>
<span class="Special">&lt;Leader&gt;</span>wd              Delete wiki page you are in.
                        Maps to <span class="Identifier">:VimwikiDeleteLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;dd &lt;Plug&gt;VimwikiDeleteLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;Leader&gt;wr</span>
<span class="Special">&lt;Leader&gt;</span>wr              Rename wiki page you are in.
                        Maps to <span class="Identifier">:VimwikiRenameLink</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;rr &lt;Plug&gt;VimwikiRenameLink</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;C-Space&gt;</span>
<span class="Special">&lt;C-Space&gt;</span>               Toggle list item on/off (checked/unchecked)
                        Maps to <span class="Identifier">:VimwikiToggleListItem</span>.
                        To remap:
<span class="Comment">                        :nmap &lt;leader&gt;tt &lt;Plug&gt;VimwikiToggleListItem</span>
                       See <span class="Identifier">vimwiki-todo-lists</span>.

<span class="Statement">                        </span><span class="String">vimwiki_=</span>
=                       Add header level. Create if needed.
                        There is nothing to indent with '==' command in
                        vimwiki, so it should be ok to use '=' here.
                        To remap:
<span class="Comment">                        :nmap == &lt;Plug&gt;VimwikiAddHeaderLevel</span>

<span class="Statement">                        </span><span class="String">vimwiki_-</span>
-                       Remove header level.
                        To remap:
<span class="Comment">                        :nmap -- &lt;Plug&gt;VimwikiRemoveHeaderLevel</span>

<span class="Statement">                        </span><span class="String">vimwiki_+</span>
+                       Create and/or decorate links.  Depending on the
                        context, this command will: convert words into
                        Wikilinks; convert raw URLs into Wikilinks; and add
                        placeholder text to Wiki- or Weblinks that are missing
                        descriptions.  Can be activated in normal mode with
                        the cursor over a word or link, or in visual mode with
                        the selected text .

<span class="Statement">                        </span><span class="String">vimwiki_glm</span>
glm                     Increase the indent of a single-line list item.

<span class="Statement">                        </span><span class="String">vimwiki_gll</span>
gll                     Decrease the indent of a single-line list item.

<span class="Statement">                        </span><span class="String">vimwiki_glstar</span> <span class="String">vimwiki_gl8</span>
gl* or gl8              Switch or insert a &quot;*&quot; symbol.  Only available in
                        supported syntaxes.

<span class="Statement">                        </span><span class="String">vimwiki_gl#</span> <span class="String">vimwiki_gl3</span>
gl# or gl3              Switch or insert a &quot;#&quot; symbol.  Only available in
                        supported syntaxes.

<span class="Statement">                        </span><span class="String">vimwiki_gl-</span>
gl-                     Switch or insert a &quot;-&quot; symbol.  Only available in
                        supported syntaxes.

<span class="Statement">                        </span><span class="String">vimwiki_gl1</span>
gl1                     Switch or insert a &quot;1.&quot; symbol.  Only available in
                        supported syntaxes.

<span class="Statement">                        </span><span class="String">vimwiki_gqq</span>  <span class="String">vimwiki_gww</span>
gqq                     Format table. If you made some changes to a table
 or                     without swapping insert/normal modes this command
gww                     will reformat it.

<span class="Statement">                        </span><span class="String">vimwiki_&lt;A-Left&gt;</span>
<span class="Special">&lt;A-Left&gt;</span>                Move current table column to the left.
                        See <span class="Identifier">:VimwikiTableMoveColumnLeft</span>
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wtl &lt;Plug&gt;VimwikiTableMoveColumnLeft</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;A-Right&gt;</span>
<span class="Special">&lt;A-Right&gt;</span>               Move current table column to the right.
                        See <span class="Identifier">:VimwikiTableMoveColumnRight</span>
                        To remap:
<span class="Comment">                        :nmap &lt;Leader&gt;wtr &lt;Plug&gt;VimwikiTableMoveColumnRight</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;C-Up&gt;</span>
<span class="Special">&lt;C-Up&gt;</span>                  Open the previous day's diary link if available.
                        See <span class="Identifier">:VimwikiDiaryPrevDay</span>

<span class="Statement">                        </span><span class="String">vimwiki_&lt;C-Down&gt;</span>
<span class="Special">&lt;C-Down&gt;</span>                Open the next day's diary link if available.
                        See <span class="Identifier">:VimwikiDiaryNextDay</span>


Works only if <span class="Identifier">g:vimwiki_use_mouse</span> is set to 1.
<span class="Special">&lt;2-LeftMouse&gt;</span>           Follow wiki link (create target wiki page if needed).

<span class="Special">&lt;S-2-LeftMouse&gt;</span>         Split and follow wiki link (create target wiki page if
                        needed).

<span class="Special">&lt;C-2-LeftMouse&gt;</span>         Vertical split and follow wiki link (create target
                        wiki page if needed).

<span class="Special">&lt;RightMouse&gt;&lt;LeftMouse&gt;</span> Go back to previous wiki page.

<span class="Todo">Note</span>: <span class="Special">&lt;2-LeftMouse&gt;</span> is just left double click.



<span class="Statement">INSERT MODE                                           </span><span class="String">vimwiki-table-mappings</span>
<span class="Statement">                        </span><span class="String">vimwiki_i_&lt;CR&gt;</span>
<span class="Special">&lt;CR&gt;</span>                    Go to the table cell beneath the current one, create
                        a new row if on the last one.

<span class="Statement">                        </span><span class="String">vimwiki_i_&lt;Tab&gt;</span>
<span class="Special">&lt;Tab&gt;</span>                   Go to the next table cell, create a new row if on the
                        last cell.
See <span class="Identifier">g:vimwiki_table_mappings</span> to turn them off.


<span class="PreProc">------------------------------------------------------------------------------</span>
3.3. Text objects                                       <span class="String">vimwiki-text-objects</span>

ah                      A section segment (the area between two consecutive
                        headings) including trailing empty lines.
ih                      A section segment without trailing empty lines.

You can <span class="Type">'vah'</span> to select a section segment with its contents or <span class="Type">'dah'</span> to delete
it or <span class="Type">'yah'</span> to yank it or <span class="Type">'cah'</span> to change it.

a\                      A cell in a table.
i\                      An inner cell in a table.
ac                      A column in a table.
ic                      An inner column in a table.


<span class="PreProc">==============================================================================</span>
4. Commands                                                 <span class="String">vimwiki-commands</span>

<span class="PreProc">------------------------------------------------------------------------------</span>
4.1. Global Commands                                 <span class="String">vimwiki-global-commands</span>

<span class="String">:VimwikiIndex</span>
    Open index file of the current wiki.

<span class="String">:VimwikiTabIndex</span>
    Open index file of the current wiki in a new tab.

<span class="String">:VimwikiUISelect</span>
    Open index file of the selected wiki.

<span class="String">:VimwikiDiaryIndex</span>
    Open diary index file of the current wiki.

<span class="String">:VimwikiMakeDiaryNote</span>
    Open diary wiki-file for today of the current wiki.

<span class="String">:VimwikiTabMakeDiaryNote</span>
    Open diary wiki-file for today of the current wiki in a new tab.


<span class="PreProc">------------------------------------------------------------------------------</span>
4.2. Local commands                                   <span class="String">vimwiki-local-commands</span>

<span class="String">:VimwikiFollowLink</span>
    Follow wiki link (create target wiki page if needed).

<span class="String">:VimwikiGoBackLink</span>
    Go back to the wiki page you came from.

<span class="String">:VimwikiSplitLink</span>
    Split and follow wiki link (create target wiki page if needed).

<span class="String">:VimwikiVSplitLink</span>
    Vertical split and follow wiki link (create target wiki page if needed).

<span class="String">:VimwikiTabnewLink</span>
    Follow wiki link in a new tab (create target wiki page if needed).

<span class="String">:VimwikiNextLink</span>
    Find next link on the current page.

<span class="String">:VimwikiPrevLink</span>
    Find previous link on the current page.

<span class="String">:VimwikiGoto</span>
    Goto link provided by an argument. For example:
<span class="Comment">        :VimwikiGoto HelloWorld</span>
   opens opens/creates HelloWorld wiki page.

<span class="String">:VimwikiDeleteLink</span>
    Delete the wiki page that you are in.

<span class="String">:VimwikiRenameLink</span>
    Rename the wiki page that you are in.

<span class="String">:Vimwiki2HTML</span>
    Convert current wiki page to HTML using vimwiki's own converter or a
    user-supplied script (see <span class="Identifier">vimwiki-option-custom_wiki2html</span>).

<span class="String">:Vimwiki2HTMLBrowse</span>
    Convert current wiki page to HTML and open it in webbrowser.

<span class="String">:VimwikiAll2HTML</span>
    Convert all wiki pages to HTML.
    Default css file (style.css) is created if there is no one.

<span class="String">:VimwikiToggleListItem</span>
    Toggle list item on/off (checked/unchecked)
    See <span class="Identifier">vimwiki-todo-lists</span>.

<span class="String">:VimwikiListChangeLevel</span> CMD
    Change the nesting level, or symbol, for a single-line list item.
    CMD may be &quot;&gt;&gt;&quot; or &quot;&lt;&lt;&quot; to change the indentation of the item, or
    one of the syntax-specific bullets: &quot;*&quot;, &quot;#&quot;, &quot;1.&quot;, &quot;-&quot;.
    See <span class="Identifier">vimwiki-todo-lists</span>.

<span class="String">:VimwikiSearch</span> /pattern/
<span class="String">:VWS</span> /pattern/
    Search for /pattern/ in all files of current wiki.
    To display all matches use <span class="Identifier">:lopen</span> command.
    To display next match use <span class="Identifier">:lnext</span> command.
    To display previous match use <span class="Identifier">:lprevious</span> command.

<span class="String">:VimwikiBacklinks</span>
<span class="String">:VWB</span>
    Search for wikilinks to the [[current wiki page]]
    in all files of current wiki.
    To display all matches use <span class="Identifier">:lopen</span> command.
    To display next match use <span class="Identifier">:lnext</span> command.
    To display previous match use <span class="Identifier">:lprevious</span> command.


<span class="String">:VimwikiTable</span>
    Create a table with 5 cols and 2 rows.

    :VimwikiTable cols rows
    Create a table with the given cols and rows

    :VimwikiTable cols
    Create a table with the given cols and 2 rows


<span class="String">:VimwikiTableMoveColumnLeft</span> , <span class="String">:VimwikiTableMoveColumnRight</span>
    Move current column to the left or to the right:
    Example:

<span class="Comment">    | head1  | head2  | head3  | head4  | head5  |</span>
<span class="Comment">    |--------|--------|--------|--------|--------|</span>
<span class="Comment">    | value1 | value2 | value3 | value4 | value5 |</span>


<span class="Comment">    Cursor is on 'head1'.</span>
<span class="Comment">    :VimwikiTableMoveColumnRight</span>

<span class="Comment">    | head2  | head1  | head3  | head4  | head5  |</span>
<span class="Comment">    |--------|--------|--------|--------|--------|</span>
<span class="Comment">    | value2 | value1 | value3 | value4 | value5 |</span>

<span class="Comment">    Cursor is on 'head3'.</span>
<span class="Comment">    :VimwikiTableMoveColumnLeft</span>

<span class="Comment">    | head2  | head3  | head1  | head4  | head5  |</span>
<span class="Comment">    |--------|--------|--------|--------|--------|</span>
<span class="Comment">    | value2 | value3 | value1 | value4 | value5 |</span>


    Commands are mapped to <span class="Special">&lt;A-Left&gt;</span> and <span class="Special">&lt;A-Right&gt;</span> respectively.


<span class="String">:VimwikiGenerateLinks</span>
    Insert all available links into current buffer.

<span class="String">:VimwikiDiaryGenerateLinks</span>
    Delete old, insert new diary section into diary index file.

<span class="String">:VimwikiDiaryNextDay</span>
    Open next day diary link if available.
    Mapped to <span class="Special">&lt;C-Down&gt;</span>.

<span class="String">:VimwikiDiaryPrevDay</span>
    Open previous day diary link if available.
    Mapped to <span class="Special">&lt;C-Up&gt;</span>.


<span class="PreProc">==============================================================================</span>
5. Wiki syntax                                                <span class="String">vimwiki-syntax</span>


There are a lot of different wikies out there. Most of them have their own
syntax and vimwiki's default syntax is not an exception here.

Vimwiki has evolved its own syntax that closely resembles google's wiki
markup.  This syntax is described in detail below.

Vimwiki also supports alternative syntaxes, like Markdown and MediaWiki, to
varying degrees; see <span class="Identifier">vimwiki-option-syntax</span>.  Static elements like headers,
quotations, and lists are customized in syntax/vimwiki_xxx.vim, where xxx
stands for the chosen syntax.

Interactive elements such as links and vimwiki commands are supported by
definitions and routines in syntax/vimwiki_xxx_custom.vim and
autoload/vimwiki/xxx_base.vim.  Currently, only Markdown includes this level
of support.

Vimwiki2HTML is currently functional only for the default syntax.

<span class="PreProc">------------------------------------------------------------------------------</span>
5.1. Typefaces                                      <span class="String">vimwiki-syntax-typefaces</span>

There are a few typefaces that gives you a bit of control over how your
text should be decorated:
<span class="Comment">  *bold text*</span>
<span class="Comment">  _italic text_</span>
<span class="Comment">  ~~strikeout text~~</span>
<span class="Comment">  `code (no syntax) text`</span>
<span class="Comment">  super^script^</span>
<span class="Comment">  sub,,script,,</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
5.2. Links                                              <span class="String">vimwiki-syntax-links</span>

<span class="PreProc">Wikilinks</span>

Link with spaces in it:
<span class="Comment">  [[This is a link]]</span>
or:
<span class="Comment">  [[This is a link source|Description of the link]]</span>

Links to directories (ending with a &quot;/&quot;) are also supported:
<span class="Comment">  [[/home/somebody/|Home Directory]]</span>

Use <span class="Identifier">g:vimwiki_dir_link</span> to control the behaviour when opening directories.

<span class="PreProc">Raw URLs</span>

Raw URLs are also supported:
<span class="Comment">  <a href="http://code.google.com/p/vimwiki">http://code.google.com/p/vimwiki</a></span>
<span class="Comment">  mailto:habamax@gmail.com</span>
<span class="Comment">  ftp://vim.org</span>


<span class="PreProc">Markdown Links</span>

These links are only available for Markdown syntax.  See
<span class="String"><a href="http://daringfireball.net/projects/markdown/syntax#link">http://daringfireball.net/projects/markdown/syntax#link</a></span>.

Inline link:
<span class="Comment">  [Looks like this](URL)</span>

Image link:
<span class="Comment">  ![Looks like this](URL)</span>

The URL can be anything recognized by vimwiki as a raw URL.


Reference-style links:
<span class="Comment">  a) [Link Name][Id] </span>
<span class="Comment">  b) [Id][], using the &quot;implicit link name&quot; shortcut</span>
<span class="Comment">  </span>
Reference style links must always include <span class="String">two</span> consecutive pairs of
[-brackets, and field entries can not use &quot;[&quot; or &quot;]&quot;.


<span class="Todo">NOTE</span>: (in Vimwiki's current implementation) Reference-style links are a hybrid
of Vimwiki's default &quot;Wikilink&quot; and the tradition reference-style link.

If the Id is defined elsewhere in the source, as per the Markdown standard:
<span class="Comment">  [Id]: URL</span>

then the URL is opened with the system default handler.  Otherwise, Vimwiki
treats the reference-style link as a Wikilink, interpreting the Id field as a
wiki page name.

Highlighting of existing links when <span class="Identifier">vimwiki-option-maxhi</span> is activated
identifies links whose Id field is not defined, either as a reference-link or
as a wiki page.

To scan the page for new or changed definitions for reference-links, simply
re-open the page &quot;:e<span class="Special">&lt;CR&gt;</span>&quot;.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.3. Headers                                          <span class="String">vimwiki-syntax-headers</span>

<span class="PreProc">= Header level 1 =</span>
By default all headers are highlighted using <span class="Identifier">hl-Title</span> highlight group.

<span class="PreProc">== Header level 2 ==</span>
You can set up different colors for each header level:
<span class="Comment">  :hi VimwikiHeader1 guifg=#FF0000</span>
<span class="Comment">  :hi VimwikiHeader2 guifg=#00FF00</span>
<span class="Comment">  :hi VimwikiHeader3 guifg=#0000FF</span>
<span class="Comment">  :hi VimwikiHeader4 guifg=#FF00FF</span>
<span class="Comment">  :hi VimwikiHeader5 guifg=#00FFFF</span>
<span class="Comment">  :hi VimwikiHeader6 guifg=#FFFF00</span>
Set up colors for all 6 header levels or none at all.

<span class="PreProc">=== Header level 3 ===</span>
<span class="PreProc">==== Header level 4 ====</span>
<span class="PreProc">===== Header level 5 =====</span>
<span class="PreProc">====== Header level 6 ======</span>


You can center your headers in HTML by placing spaces before the first '=':
                     <span class="PreProc">= Centered Header L1 =</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
5.4. Paragraphs                                    <span class="String">vimwiki-syntax-paragraphs</span>

A paragraph is a group of lines starting in column 1 (no indentation).
Paragraphs are separated by a blank line:

This is first paragraph
with two lines.

This is a second paragraph with
two lines.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.5. Lists                                              <span class="String">vimwiki-syntax-lists</span>

Unordered lists:
<span class="Comment">  * Bulleted list item 1</span>
<span class="Comment">  * Bulleted list item 2</span>
<span class="Comment">    * Bulleted list sub item 1</span>
<span class="Comment">    * Bulleted list sub item 2</span>
<span class="Comment">    * more ...</span>
<span class="Comment">      * and more ...</span>
<span class="Comment">      * ...</span>
<span class="Comment">    * Bulleted list sub item 3</span>
<span class="Comment">    * etc.</span>
or:
<span class="Comment">  - Bulleted list item 1</span>
<span class="Comment">  - Bulleted list item 2</span>
<span class="Comment">    - Bulleted list sub item 1</span>
<span class="Comment">    - Bulleted list sub item 2</span>
<span class="Comment">    - more ...</span>
<span class="Comment">      - and more ...</span>
<span class="Comment">      - ...</span>
<span class="Comment">    - Bulleted list sub item 3</span>
<span class="Comment">    - etc.</span>

or mix:
<span class="Comment">  - Bulleted list item 1</span>
<span class="Comment">  - Bulleted list item 2</span>
<span class="Comment">    * Bulleted list sub item 1</span>
<span class="Comment">    * Bulleted list sub item 2</span>
<span class="Comment">    * more ...</span>
<span class="Comment">      - and more ...</span>
<span class="Comment">      - ...</span>
<span class="Comment">    * Bulleted list sub item 3</span>
<span class="Comment">    * etc.</span>

Ordered lists:
<span class="Comment">  # Numbered list item 1</span>
<span class="Comment">  # Numbered list item 2</span>
<span class="Comment">    # Numbered list sub item 1</span>
<span class="Comment">    # Numbered list sub item 2</span>
<span class="Comment">    # more ...</span>
<span class="Comment">      # and more ...</span>
<span class="Comment">      # ...</span>
<span class="Comment">    # Numbered list sub item 3</span>
<span class="Comment">    # etc.</span>

It is possible to mix bulleted and numbered lists:
<span class="Comment">  * Bulleted list item 1</span>
<span class="Comment">  * Bulleted list item 2</span>
<span class="Comment">    # Numbered list sub item 1</span>
<span class="Comment">    # Numbered list sub item 2</span>

<span class="Todo">Note</span> that a space after *, - or # is essential.

Multiline list items:
<span class="Comment">  * Bulleted list item 1</span>
<span class="Comment">    List item 1 continued line.</span>
<span class="Comment">    List item 1 next continued line.</span>
<span class="Comment">  * Bulleted list item 2</span>
<span class="Comment">    * Bulleted list sub item 1</span>
<span class="Comment">      List sub item 1 continued line.</span>
<span class="Comment">      List sub item 1 next continued line.</span>
<span class="Comment">    * Bulleted list sub item 2</span>
<span class="Comment">    * etc.</span>

Definition lists:
Term 1:: Definition 1
Term 2::
:: Definition 2
:: Definition 3


<span class="PreProc">------------------------------------------------------------------------------</span>
5.6. Tables                                            <span class="String">vimwiki-syntax-tables</span>

Tables are created by entering the content of each cell separated by |
delimiters. You can insert other inline wiki syntax in table cells, including
typeface formatting and links.
For example:

<span class="Comment"> | Year | Temperature (low) | Temperature (high) |</span>
<span class="Comment"> |------|-------------------|--------------------|</span>
<span class="Comment"> | 1900 | -10               | 25                 |</span>
<span class="Comment"> | 1910 | -15               | 30                 |</span>
<span class="Comment"> | 1920 | -10               | 32                 |</span>
<span class="Comment"> | 1930 | _N/A_             | _N/A_              |</span>
<span class="Comment"> | 1940 | -2                | 40                 |</span>


In HTML the following part
<span class="Comment"> | Year | Temperature (low) | Temperature (high) |</span>
<span class="Comment"> |------|-------------------|--------------------|</span>

is higlighted as a table header.

If you indent a table then it will be centered in HTML.

If you set &gt; in a cell, the cell spans the left column.
If you set \/ in a cell, the cell spans the above row.
For example:

<span class="Comment"> | a  | b  | c | d |</span>
<span class="Comment"> | \/ | e  | &gt; | f |</span>
<span class="Comment"> | \/ | \/ | &gt; | g |</span>
<span class="Comment"> | h  | &gt;  | &gt; | &gt; |</span>


See <span class="Identifier">vimwiki-tables</span> for more details on how to manage tables.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.7. Preformatted text                           <span class="String">vimwiki-syntax-preformatted</span>

Use {{{ and }}} to define a block of preformatted text:
{{{
<span class="Comment">  Tyger! Tyger! burning bright</span>
<span class="Comment">   In the forests of the night,</span>
<span class="Comment">    What immortal hand or eye</span>
<span class="Comment">     Could frame thy fearful symmetry?</span>
<span class="Comment">  In what distant deeps or skies</span>
<span class="Comment">   Burnt the fire of thine eyes?</span>
<span class="Comment">    On what wings dare he aspire?</span>
<span class="Comment">     What the hand dare sieze the fire?</span>
}}}


You can add optional information to {{{ tag:
{{{class=&quot;brush: python&quot;
<span class="Comment"> def hello(world):</span>
<span class="Comment">     for x in range(10):</span>
<span class="Comment">         print(&quot;Hello {0} number {1}&quot;.format(world, x))</span>
}}}

Result of HTML export:
<span class="Comment"> &lt;pre class=&quot;brush: python&quot;&gt;</span>
<span class="Comment"> def hello(world):</span>
<span class="Comment">     for x in range(10):</span>
<span class="Comment">         print(&quot;Hello {0} number {1}&quot;.format(world, x))</span>
<span class="Comment"> &lt;/pre&gt;</span>

This might be useful for coloring program code with external js tools
such as google's syntax highlighter.

You can setup vimwiki to highlight code snippets in preformatted text.
See <span class="Identifier">vimwiki-option-nested_syntaxes</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
5.8. Mathematical formulae                              <span class="String">vimwiki-syntax-math</span>

Mathematical formulae are highlighted, and can be rendered in HTML using the
powerful open source display engine MathJax (<span class="String"><a href="http://www.mathjax.org/">http://www.mathjax.org/</a></span>).

There are three supported syntaxes, which are inline, block display and
block environment.

Inline math is for short formulae within text. It is enclosed by single
dollar signs, e.g.:
 $ \sum_i a_i^2 = 1 $

Block display creates a centered formula with some spacing before and after
it. It must start with a line including only {{$, then an arbitrary number
of mathematical text are allowed, and it must end with a line including only
}}$.
E.g.:
 {{$
 \sum_i a_i^2
 =
 1
 }}$

<span class="Todo">Note</span>: no matter how many lines are used in the text file, the HTML will
compress it to <span class="String">one</span> line only.

Block environment is similar to block display, but is able to use specific
LaTeX environments, such as <span class="Type">'align'</span>. The syntax is the same as for block
display, except for the first line which is {{$%environment%.
E.g.:
 {{$%align%
 \sum_i a_i^2 &amp;= 1 + 1 \\
 &amp;= 2.
 }}$

Similar compression rules for the HTML page hold (as MathJax interprets the
LaTeX code).

<span class="Todo">Note</span>: the highlighting in VIM is automatic. For the rendering in HTML, you
have two <span class="String">alternative</span> options:

1. using the MathJax server for rendering (needs an internet connection).
Add to your HTML template the following line:

&lt;script type=&quot;text/javascript&quot; src=&quot;<span class="String"><a href="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML</a></span>&quot;&gt;&lt;/script&gt;

2. installing MathJax locally (faster, no internet required). Choose a
folder on your hard drive and save MathJax in it. Then add to your HTML
template the following line:

&lt;script type=&quot;text/javascript&quot; src=&quot;<span class="Special">&lt;mathjax_folder&gt;</span>/MathJax.js?config=TeX-AMS-MML_HTMLorMML&quot;&gt;&lt;/script&gt;

where <span class="Special">&lt;mathjax_folder&gt;</span> is the folder on your HD, as a relative path to the
template folder. For instance, a sensible folder structure could be:

- wiki
  - text
  - html
  - templates
  - mathjax

In this case, <span class="Special">&lt;mathjax_folder&gt;</span> would be &quot;../mathjax&quot; (without quotes).


<span class="PreProc">------------------------------------------------------------------------------</span>
5.9. Blockquotes                                  <span class="String">vimwiki-syntax-blockquotes</span>

Text started with 4 or more spaces is a blockquote.

    This would be a blockquote in vimwiki. It is not highlighted in vim but
    could be styled by CSS in HTML. Blockquotes are usually used to quote a
    long piece of text from another source.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.10. Comments                                        <span class="String">vimwiki-syntax-comments</span>

Text line started with %% is a comment.
E.g.:
<span class="Comment"> %% this text would not be in HTML</span>



<span class="PreProc">------------------------------------------------------------------------------</span>
5.11. Horizontal line                                      <span class="String">vimwiki-syntax-hr</span>

4 or more dashes at the start of the line is a 'horizontal line' (&lt;hr /&gt;):
<span class="Comment"> ----</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
5.12. Schemes                                           <span class="String">vimwiki-syntax-schemes</span>

In addition to standard web schemes (e.g. <span class="Comment">http:</span>, <span class="Comment">https:</span>, <span class="Comment">ftp:</span>, etc.) a
number of special schemes are supported: &quot;wiki#:&quot;, &quot;local:&quot;, &quot;diary:&quot;,
&quot;file:&quot;, and schemeless.

While &quot;wiki:#&quot;, &quot;diary&quot; and schemeless links are automatically opened in Vi,
all other links are opened with the system command.  To customize this
behavior, see <span class="Identifier">VimwikiLinkHandler</span>.

<span class="PreProc">Interwiki:</span>

If you maintain more than one wiki, you can create interwiki links between them
by adding a numbered prefix &quot;wiki#:&quot; in front of a link:
<span class="Comment">  [[wiki#:This is a link]]</span>
or:
<span class="Comment">  [[wiki#:This is a link source|Description of the link]]</span>

The number &quot;#&quot;, in the range 0..<span class="Special">N</span>-1, identifies the destination wiki in
<span class="Identifier">g:vimwiki_list</span>.

<span class="PreProc">Diary:</span>

The diary scheme is used to concisely link to diary entries:
<span class="Comment">  [[diary:2012-03-05]]</span>

This scheme precludes explicit inclusion of <span class="Identifier">vimwiki-option-diary_rel_path</span>,
and is most useful on subwiki pages to avoid links such as:
<span class="Comment">  [[../../diary/2012-03-05]]</span>

<span class="PreProc">Local:</span>

A local resource that is not a wiki page may be specified with a path relative
to the current page:
<span class="Comment">  [[local:../assets/data.csv|data (CSV)]]</span>

When followed or converted to HTML, extensions of local-scheme links are not
modified.

<span class="PreProc">File:</span>

The file scheme allows you to directly link to arbitray resources using
absolute paths and extensions:
<span class="Comment">  [[file:///home/somebody/a/b/c/music.mp3]]</span>

<span class="PreProc">Schemeless:</span>

Schemeless URLs, which are the default, are treated internally as &quot;wiki#:&quot;
URLs in all respects except when converted to Html.

Schemeless links convert to plain relative path URLs, nearly verbatim:
<span class="Comment">  relpath/wikipage.html</span>

The &quot;wiki#:&quot;, &quot;local:&quot;, and &quot;diary:&quot; schemes use absolute paths as URLs:
<span class="Comment">  file:///abs_path_to_html#/relpath/wikipage.html</span>

When <span class="Identifier">vimwiki-option-maxhi</span> equals 1, a distinct highlighting style is used to
identify schemeless links whose targets are not found.  All other links appear
as regular links even if the files to which they refer do not exist.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.13. Transclusions                                <span class="String">vimwiki-syntax-transclude</span>

<span class="PreProc">Transclusion (Wiki-Include) Links</span>

Links that use &quot;{{&quot; and &quot;}}&quot; delimiters signify content that is to be
included into the Html output, rather than referenced via hyperlink.

Wiki-include URLs may use any of the supported schemes, may be absolute or
relative, and need not end with an extension.

The primary purpose for wiki-include links is to include images.

Transclude from a local URL:
<span class="Comment">  {{local:../../images/vimwiki_logo.png}}</span>
or from a universal URL:
<span class="Comment">  {{<a href="http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png}}">http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png}}</a></span>

Transclude image with alternate text:
<span class="Comment">  {{<a href="http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png|Vimwiki}}">http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png|Vimwiki}}</a></span>
in HTML:
<span class="Comment">  &lt;img src=&quot;<a href="http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png">http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png</a>&quot; </span>
<span class="Comment">  alt=&quot;Vimwiki&quot;/&gt;</span>

Transclude image with alternate text and some style:
<span class="Comment">  {{<a href="http://.../vimwiki_logo.png|cool">http://.../vimwiki_logo.png|cool</a> stuff|style=&quot;width:150px; height: 120px;&quot;}}</span>
in HTML:
<span class="Comment">  &lt;img src=&quot;<a href="http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png">http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png</a>&quot; </span>
<span class="Comment">  alt=&quot;cool stuff&quot; style=&quot;width:150px; height:120px&quot;/&gt;</span>

Transclude image _without_ alternate text and with css class:
<span class="Comment">  {{<a href="http://.../vimwiki_logo.png||class=">http://.../vimwiki_logo.png||class=</a>&quot;center flow blabla&quot;}}</span>
in HTML:
<span class="Comment">  &lt;img src=&quot;<a href="http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png">http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png</a>&quot; </span>
<span class="Comment">  alt=&quot;&quot; class=&quot;center flow blabla&quot;/&gt;</span>

A trial feature allows you to supply your own handler for wiki-include links.
See <span class="Identifier">VimwikiWikiIncludeHandler</span>.


<span class="PreProc">------------------------------------------------------------------------------</span>
5.14. Thumbnails                                    <span class="String">vimwiki-syntax-thumbnails</span>

<span class="PreProc">Thumbnail links</span>

Thumbnail links are constructed like this:
<span class="Comment">  [[<a href="http://someaddr.com/bigpicture.jpg|{{http://someaddr.com/thumbnail.jpg}}]]">http://someaddr.com/bigpicture.jpg|{{http://someaddr.com/thumbnail.jpg}}]]</a></span>

in HTML:
<span class="Comment">  &lt;a href=&quot;<a href="http://someaddr.com/">http://someaddr.com/</a> ... /.jpg&quot;&gt;</span>
<span class="Comment">  &lt;img src=&quot;<a href="http://../thumbnail.jpg">http://../thumbnail.jpg</a> /&gt;&lt;/a&gt;</span>




<span class="PreProc">==============================================================================</span>
6. Folding/Outline                                           <span class="String">vimwiki-folding</span>

Vimwiki can fold or outline sections using headers and preformatted blocks.
Alternatively, one can fold list subitems instead.

Example for list folding:
= My current task =
<span class="Statement">  </span>* [ ] Do stuff 1
<span class="Statement">    </span>* [ ] Do substuff 1.1
<span class="Statement">    </span>* [ ] Do substuff 1.2
<span class="Statement">      </span>* [ ] Do substuff 1.2.1
<span class="Statement">      </span>* [ ] Do substuff 1.2.2
<span class="Statement">    </span>* [ ] Do substuff 1.3
<span class="Statement">  </span>* [ ] Do stuff 2
<span class="Statement">  </span>* [ ] Do stuff 3

Hit <span class="Identifier">zM</span> :
<span class="PreProc">= My current task = [8] --------------------------------------</span>

Hit <span class="Identifier">zr</span> :
<span class="PreProc">= My current task =</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 1 [5] --------------------------------------</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 2</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 3</span>

Hit <span class="Identifier">zr</span> one more time:
<span class="PreProc">= My current task =</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 1</span>
<span class="Statement">    </span><span class="PreProc">* [ ] Do substuff 1.1</span>
<span class="Statement">    </span><span class="PreProc">* [ ] Do substuff 1.2 [2] -------------------------------</span>
<span class="Statement">    </span><span class="PreProc">* [ ] Do substuff 1.3</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 2</span>
<span class="Statement">  </span><span class="PreProc">* [ ] Do stuff 3</span>

<span class="Todo">NOTE</span>:If you use the default vimwiki syntax, folding on list items will work
properly only if all of them are indented using current <span class="Identifier">shiftwidth</span>.
For MediaWiki, * or # should be in the first column.

To turn folding on/off check <span class="Identifier">g:vimwiki_folding</span>.


<span class="PreProc">==============================================================================</span>
7. Placeholders                                         <span class="String">vimwiki-placeholders</span>

<span class="PreProc">------------------------------------------------------------------------------</span>
%toc Table of Contents               <span class="String">vimwiki-toc</span> <span class="String">vimwiki-table-of-contents</span>

You can add 'table of contents' to your HTML page generated from wiki one.
Just place

%toc

into your wiki page.
You can also add a caption to your <span class="Type">'toc'</span>:

%toc Table of Contents

or

%toc Whatever


<span class="PreProc">------------------------------------------------------------------------------</span>
%title Title of the page                                       <span class="String">vimwiki-title</span>

When you htmlize your wiki page, the default title is the filename of the
page. Place

%title My books

into your wiki page if you want another title.


<span class="PreProc">------------------------------------------------------------------------------</span>
%nohtml                                                       <span class="String">vimwiki-nohtml</span>

If you do not want a wiki page to be converted to HTML, place:

%nohtml

into it.


<span class="PreProc">------------------------------------------------------------------------------</span>
%template                                                   <span class="String">vimwiki-template</span>

To apply a concrete HTML template to a wiki page, place:

%template name

into it.

See <span class="Identifier">vimwiki-option-template_path</span> for details.


<span class="PreProc">==============================================================================</span>
8. Todo lists                                             <span class="String">vimwiki-todo-lists</span>

You can have todo lists -- lists of items you can check/uncheck.

Consider the following example:
= Toggleable list of todo items =
<span class="Statement">  </span>* [X] Toggle list item on/off.
<span class="Statement">    </span>* [X] Simple toggling between [ ] and [X].
<span class="Statement">    </span>* [X] All list's subitems should be toggled on/off appropriately.
<span class="Statement">    </span>* [X] Toggle child subitems only if current line is list item
<span class="Statement">    </span>* [X] Parent list item should be toggled depending on it's child items.
<span class="Statement">  </span>* [X] Make numbered list items toggleable too
<span class="Statement">  </span>* [X] Add highlighting to list item boxes
<span class="Statement">  </span>* [X] Add [ ] to the next created with o, O and <span class="Special">&lt;CR&gt;</span> list item.

Pressing <span class="Special">&lt;C-Space&gt;</span> on the first list item will toggle it and all of its child
items:
= Toggleable list of todo items =
<span class="Statement">  </span>* [ ] Toggle list item on/off.
<span class="Statement">    </span>* [ ] Simple toggling between [ ] and [X].
<span class="Statement">    </span>* [ ] All of a list's subitems should be toggled on/off appropriately.
<span class="Statement">    </span>* [ ] Toggle child subitems only if the current line is a list item.
<span class="Statement">    </span>* [ ] Parent list item should be toggled depending on their child items.
<span class="Statement">  </span>* [X] Make numbered list items toggleable too.
<span class="Statement">  </span>* [X] Add highlighting to list item boxes.
<span class="Statement">  </span>* [X] Add [ ] to the next list item created using o, O or <span class="Special">&lt;CR&gt;</span>.

Pressing <span class="Special">&lt;C-Space&gt;</span> on the third list item will toggle it and adjust all of its
parent items:
= Toggleable list of todo items =
<span class="Statement">  </span>* [.] Toggle list item on/off.
<span class="Statement">    </span>* [ ] Simple toggling between [ ] and [X].
<span class="Statement">    </span>* [X] All of a list's subitems should be toggled on/off appropriately.
<span class="Statement">    </span>* [ ] Toggle child subitems only if current line is list item.
<span class="Statement">    </span>* [ ] Parent list item should be toggled depending on it's child items.
<span class="Statement">  </span>* [ ] Make numbered list items toggleable too.
<span class="Statement">  </span>* [ ] Add highlighting to list item boxes.
<span class="Statement">  </span>* [ ] Add [ ] to the next list item created using o, O or <span class="Special">&lt;CR&gt;</span>.

Parent items could be changed when their child items change. The symbol
between [ ] depends on the percentage of toggled child items (see also
<span class="Identifier">g:vimwiki_listsyms</span>):
<span class="Comment">    [ ] -- 0%</span>
<span class="Comment">    [.] -- 1-33%</span>
<span class="Comment">    [o] -- 34-66%</span>
<span class="Comment">    [O] -- 67-99%</span>
<span class="Comment">    [X] -- 100%</span>

It is possible to toggle several list items using visual mode.

<span class="Statement">                                                   </span><span class="String">vimwiki-list-manipulation</span>
The indentation and bullet symbols for list items can be manipulated using
several mappings.  Examples below demonstrate this behavior for the <span class="Type">'default'</span>
syntax and with <span class="Identifier">vimwiki-option-list_margin</span> = 1.

<span class="Comment">     Mapping    |      Input       |     Output       </span>
<span class="Comment">   ----------------------------------------------------</span>
<span class="Comment">       glm      |   ^item          |   ^ - item       </span>
<span class="Comment">       glm      |   ^     item     |   ^     - item   </span>
<span class="Comment">       gll      |   ^ - item       |   ^item          </span>
<span class="Comment">       glm      |   ^   # item     |   ^   item       </span>
<span class="Comment">       gl*      |   ^ item         |   ^ * item       </span>
<span class="Comment">       gl-      |   ^  item        |   ^  - item      </span>
<span class="Comment">       gl3      |   ^   item       |   ^   # item     </span>

See <span class="Identifier">vimwiki_gll</span>, <span class="Identifier">vimwiki_glm</span>, <span class="Identifier">vimwiki_glstar</span>, <span class="Identifier">vimwiki_gl8</span>
<span class="Identifier">vimwiki_gl#</span>, <span class="Identifier">vimwiki_gl3</span>, <span class="Identifier">vimwiki_gl-</span>, <span class="Identifier">vimwiki_gl1</span>
<span class="PreProc">==============================================================================</span>
9. Tables                                                     <span class="String">vimwiki-tables</span>

Use the  :VimwikiTable command to create a default table with 5 columns and 2
rows:
<span class="Comment"> </span>
<span class="Comment"> |   |   |   |   |   |</span>
<span class="Comment"> |---|---|---|---|---|</span>
<span class="Comment"> |   |   |   |   |   |</span>


Tables are auto-formattable. Let's add some text into first cell:

<span class="Comment"> | First Name  |   |   |   |   |</span>
<span class="Comment"> |---|---|---|---|---|</span>
<span class="Comment"> |   |   |   |   |   |</span>


Whenever you press <span class="Special">&lt;TAB&gt;</span>, <span class="Special">&lt;CR&gt;</span> or leave Insert mode, the table is formatted:

<span class="Comment"> | First Name |   |   |   |   |</span>
<span class="Comment"> |------------|---|---|---|---|</span>
<span class="Comment"> |            |   |   |   |   |</span>


You can easily create nice-looking text tables, just press <span class="Special">&lt;TAB&gt;</span> and enter new
values:

<span class="Comment"> | First Name | Last Name  | Age | City     | e-mail               |</span>
<span class="Comment"> |------------|------------|-----|----------|----------------------|</span>
<span class="Comment"> | Vladislav  | Pokrishkin | 31  | Moscow   | vlad_pok@smail.com   |</span>
<span class="Comment"> | James      | Esfandiary | 27  | Istanbul | esfandiary@tmail.com |</span>


To indent table indent the first row. Then format it with <span class="Type">'gqq'</span>.


<span class="PreProc">==============================================================================</span>
10. Diary                                                      <span class="String">vimwiki-diary</span>

The diary helps you make daily notes. You can easily add information into
vimwiki that should be sorted out later. Just hit <span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>w to create
new daily <span class="Todo">note</span> with name based on current date.

To generate diary section with all available links one can use
<span class="Identifier">:VimwikiDiaryGenerateLinks</span> or <span class="Special">&lt;Leader&gt;</span>w<span class="Special">&lt;Leader&gt;</span>i .

<span class="Todo">Note</span>: it works only for diary index file.

Example of diary section:
<span class="Comment">    = Diary =</span>

<span class="Comment">    == 2011 ==</span>

<span class="Comment">    === December ===</span>
<span class="Comment">        * [[2011-12-09]]</span>
<span class="Comment">        * [[2011-12-08]]</span>


See <span class="Identifier">g:vimwiki_diary_months</span> if you would like to rename months.



Calendar integration                                        <span class="String">vimwiki-calendar</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
If you have Calendar.vim installed you can use it to create diary notes.
Just open calendar with :Calendar and tap <span class="Special">&lt;Enter&gt;</span> on the date. A wiki file
will be created in the default wiki's diary.

Get it from <span class="String"><a href="http://www.vim.org/scripts/script.php?script_id=52">http://www.vim.org/scripts/script.php?script_id=52</a></span>

See <span class="Identifier">g:vimwiki_use_calendar</span> option to turn it off/on.



<span class="PreProc">==============================================================================</span>
11. Options                                                  <span class="String">vimwiki-options</span>

There are global options and local (per-wiki) options available to tune
vimwiki.

Global options are configured via global variables.  For a complete list of
them, see <span class="Identifier">viwmiki-global-options</span>.

Local options for multiple independent wikis are stored in a single global
variable <span class="Identifier">g:vimwiki_list</span>.  The per-wiki options can be registered in advance,
as described in <span class="Identifier">vimwiki-register-wiki</span>, or may be registered on the fly as
described in <span class="Identifier">vimwiki-temporary-wiki</span>.  For a list of per-wiki options, see
<span class="Identifier">vimwiki-local-options</span>.


<span class="PreProc">------------------------------------------------------------------------------</span>
11.1 Registered Wiki                    <span class="String">g:vimwiki_list</span> <span class="String">vimwiki-register-wiki</span>

One or more wikis can be registered using the <span class="Identifier">g:vimwiki_list</span> variable.

Each item in <span class="Identifier">g:vimwiki_list</span> is a <span class="Identifier">Dictionary</span> that holds all customizations
available for a distinct wiki. The options dictionary has the form:
<span class="Comment">  {'option1': 'value1', 'option2: 'value2', ...}</span>

Consider the following:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', 'path_html': '~/public_html/'}]</span>

This defines one wiki located at ~/my_site/ that could be htmlized to
~/public_html/

Another example:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', 'path_html': '~/public_html/'},</span>
<span class="Comment">            \ {'path': '~/my_docs/', 'ext': '.mdox'}]</span>

defines two wikis: the first as before, and the second one located in
~/my_docs/, with files that have the .mdox extension.

An empty <span class="Identifier">Dictionary</span> in g:vimwiki_list is the wiki with default options:
<span class="Comment">  let g:vimwiki_list = [{},</span>
<span class="Comment">            \ {'path': '~/my_docs/', 'ext': '.mdox'}]</span>

For clarity, in your .vimrc file you can define wiki options using separate
<span class="Identifier">Dictionary</span> variables and subsequently compose them into <span class="Identifier">g:vimwiki_list</span>.
<span class="Comment">    let wiki_1 = {}</span>
<span class="Comment">    let wiki_1.path = '~/my_docs/'</span>
<span class="Comment">    let wiki_1.html_template = '~/public_html/template.tpl'</span>
<span class="Comment">    let wiki_1.nested_syntaxes = {'python': 'python', 'c++': 'cpp'}</span>

<span class="Comment">    let wiki_2 = {}</span>
<span class="Comment">    let wiki_2.path = '~/project_docs/'</span>
<span class="Comment">    let wiki_2.index = 'main'</span>

<span class="Comment">    let g:vimwiki_list = [wiki_1, wiki_2]</span>



<span class="PreProc">------------------------------------------------------------------------------</span>
11.2 Temporary Wiki                                    <span class="String">vimwiki-temporary-wiki</span>


The creation of temporary wikis allows you to open files that would not
normally be recognized by vimwiki.

If a file with a registered wiki extension (see <span class="Identifier">vimwiki-register-extension</span>)
is opened in a directory that: 1) is not listed in <span class="Identifier">g:vimwiki_list</span>, and 2) is
not a subdirectory of any such directory, then a temporary wiki may be created
and appended to the list of configured wikis in <span class="Identifier">g:vimwiki_list</span>.

In addition to vimwiki's editing functionality, the temporary wiki enables: 1)
wiki-linking to other files in the same subtree, 2) highlighting of existing
wiki pages when <span class="Identifier">vimwiki-option-maxhi</span> is activated, and 3) html generation to
<span class="Identifier">vimwiki-option-path_html</span>.

Temporary wikis are configured using default <span class="Identifier">vimwiki-local-options</span>, except
for the path, extension, and syntax options.  The path and extension are set
using the file's location and extension.  The syntax is set to vimwiki's
default unless another syntax is registered via <span class="Identifier">vimwiki-register-extension</span>.

Use <span class="Identifier">g:vimwiki_global_ext</span> to turn off creation of temporary wikis.

<span class="Todo">NOTE</span>: Vimwiki assumes that the locations of distinct wikis do not overlap.


<span class="PreProc">------------------------------------------------------------------------------</span>
11.3 Per-Wiki Options                                  <span class="String">vimwiki-local-options</span>


<span class="String">vimwiki-option-path</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
path            ~/vimwiki/

<span class="PreProc">Description</span>
Wiki files location:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/'}]</span>


<span class="String">vimwiki-option-path_html</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
path_html       ''

<span class="PreProc">Description</span>
Location of HTML files converted from wiki files:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/',</span>
<span class="Comment">                       \ 'path_html': '~/html_site/'}]</span>

If path_html is an empty string, the location is derived from
<span class="Identifier">vimwiki-option-path</span> by adding '_html'; i.e. for:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/okidoki/'}]</span>

path_html will be set to '~/okidoki_html/'.


<span class="String">vimwiki-option-auto_export</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value     Values</span>
auto_export     0                 0, 1

<span class="PreProc">Description</span>
Set this option to 1 to automatically generate the HTML file when the
corresponding wiki page is saved:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', 'auto_export': 1}]</span>

This will keep your HTML files up to date.

<span class="String">vimwiki-option-index</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
index           index

<span class="PreProc">Description</span>
Name of wiki index file:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', 'index': 'main'}]</span>

<span class="Todo">NOTE</span>: Do not include the extension.


<span class="String">vimwiki-option-ext</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
ext             .wiki

<span class="PreProc">Description</span>
Extension of wiki files:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/',</span>
<span class="Comment">                       \ 'index': 'main', 'ext': '.document'}]</span>


<span class="String">vimwiki-option-syntax</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value     Values</span>
syntax          default           default, markdown, or media

<span class="PreProc">Description</span>
Wiki syntax.  You can use different markup languages (currently: vimwiki's
default, Markdown, and MediaWiki), but only vimwiki's default markup will be
converted to HTML at the moment.

To use Markdown's wiki markup:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', </span>
<span class="Comment">                       \ 'syntax': 'markdown', 'ext': '.md'}]</span>


<span class="String">vimwiki-option-template_path</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key                 Default value</span>
template_path       ~/vimwiki/templates/

<span class="PreProc">Description</span>
Setup path for HTML templates:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/',</span>
<span class="Comment">          \ 'template_path': '~/public_html/templates/',</span>
<span class="Comment">          \ 'template_default': 'def_template',</span>
<span class="Comment">          \ 'template_ext': '.html'}]</span>

There could be a bunch of templates:
<span class="Comment">    def_template.html</span>
<span class="Comment">    index.html</span>
<span class="Comment">    bio.html</span>
<span class="Comment">    person.html</span>
etc.

Each template could look like:
<span class="Comment">    &lt;html&gt;</span>
<span class="Comment">    &lt;head&gt;</span>
<span class="Comment">        &lt;link rel=&quot;Stylesheet&quot; type=&quot;text/css&quot; href=&quot;%root_path%style.css&quot; /&gt;</span>
<span class="Comment">        &lt;title&gt;%title%&lt;/title&gt;</span>
<span class="Comment">        &lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=utf-8&quot; /&gt;</span>
<span class="Comment">    &lt;/head&gt;</span>
<span class="Comment">    &lt;body&gt;</span>
<span class="Comment">        &lt;div class=&quot;content&quot;&gt;</span>
<span class="Comment">        %content%</span>
<span class="Comment">        &lt;/div&gt;</span>
<span class="Comment">    &lt;/body&gt;</span>
<span class="Comment">    &lt;/html&gt;</span>

where
  %title% is replaced by a wiki page name or by a <span class="Identifier">vimwiki-title</span>
  %root_path% is replaced by a count of ../ for pages buried in subdirs:
    if you have wikilink [[dir1/dir2/dir3/my page in a subdir]] then
    %root_path% is replaced by '../../../'.

  %content% is replaced by a wiki file content.


The default template will be applied to all wiki pages unless a page specifies
a template. Consider you have wiki page named 'Maxim.wiki' and you want apply
'person.html' template to it. Just add:
<span class="Comment"> %template person</span>
to that page.


<span class="String">vimwiki-option-template_default</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key                 Default value</span>
template_default    default

<span class="PreProc">Description</span>
Setup default template name (without extension).

See <span class="Identifier">vimwiki-option-template_path</span> for details.


<span class="String">vimwiki-option-template_ext</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key                 Default value</span>
template_ext        .html

<span class="PreProc">Description</span>
Setup template filename extension.

See <span class="Identifier">vimwiki-option-template_path</span> for details.


<span class="String">vimwiki-option-css_name</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
css_name        style.css

<span class="PreProc">Description</span>
Setup CSS file name:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_pages/',</span>
<span class="Comment">          \ 'css_name': 'main.css'}]</span>

or even
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_pages/',</span>
<span class="Comment">          \ 'css_name': 'css/main.css'}]</span>



<span class="String">vimwiki-option-maxhi</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value     Values</span>
maxhi           0                 0, 1

<span class="PreProc">Description</span>
Non-existent wiki links highlighting can be quite slow. If you still want it,
set maxhi to 1:
<span class="Comment">  let g:vimwiki_list = [{'path': '~/my_site/', 'maxhi': 1}]</span>

This disables filesystem checks for wiki links.


<span class="String">vimwiki-option-nested_syntaxes</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value     Values</span>
nested_syntaxes {}                pairs of highlight keyword and vim filetype

<span class="PreProc">Description</span>
You can configure preformatted text to be highlighted with any syntax
available for vim.
For example the following setup in your vimrc:
<span class="Comment">  let wiki = {}</span>
<span class="Comment">  let wiki.path = '~/my_wiki/'</span>
<span class="Comment">  let wiki.nested_syntaxes = {'python': 'python', 'c++': 'cpp'}</span>
<span class="Comment">  let g:vimwiki_list = [wiki]</span>

would give you Python and C++ highlighting in:
<span class="Comment"> {{{class=&quot;brush: python&quot;</span>
<span class="Comment"> for i in range(1, 5):</span>
<span class="Comment">     print(i)</span>
<span class="Comment"> }}}</span>

<span class="Comment"> {{{class=&quot;brush: c++&quot;</span>
<span class="Comment"> #include &quot;helloworld.h&quot;</span>
<span class="Comment"> int helloworld()</span>
<span class="Comment"> {</span>
<span class="Comment">    printf(&quot;hello world&quot;);</span>
<span class="Comment"> }</span>
<span class="Comment"> }}}</span>

or in:
<span class="Comment"> {{{c++</span>
<span class="Comment"> #include &quot;helloworld.h&quot;</span>
<span class="Comment"> int helloworld()</span>
<span class="Comment"> {</span>
<span class="Comment">    printf(&quot;hello world&quot;);</span>
<span class="Comment"> }</span>
<span class="Comment"> }}}</span>

<span class="Comment"> {{{python</span>
<span class="Comment"> for i in range(1, 5):</span>
<span class="Comment">     print(i)</span>
<span class="Comment"> }}}</span>


<span class="String">vimwiki-option-diary_rel_path</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
diary_rel_path  diary/

<span class="PreProc">Description</span>
Related to <span class="Identifier">vimwiki-option-path</span> path for diary wiki-files.


<span class="String">vimwiki-option-diary_index</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
diary_index     diary

<span class="PreProc">Description</span>
Name of wiki-file that holds all links to dated wiki-files.


<span class="String">vimwiki-option-diary_header</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value</span>
diary_header    Diary

<span class="PreProc">Description</span>
Name of the header in <span class="Identifier">vimwiki-option-diary_index</span> where links to dated
wiki-files are located.


<span class="String">vimwiki-option-diary_sort</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key             Default value   Values</span>
diary_sort      desc            desc, asc

<span class="PreProc">Description</span>
Sort links in a diary index page.


<span class="String">vimwiki-option-custom_wiki2html</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key               Default value</span>
custom_wiki2html  ''

<span class="PreProc">Description</span>
The full path to an user-provided script that converts a wiki page to HTML.
Vimwiki calls the provided <span class="Identifier">vimwiki-option-custom_wiki2html</span> script from the
command-line, using '!' invocation.

The following arguments, in this order, are passed to the
<span class="Identifier">vimwiki-option-custom_wiki2html</span> script:

1. force : [0/1] overwrite an existing file
2. syntax : the syntax chosen for this wiki
3. extension : the file extension for this wiki
4. output_dir : the full path of the output directory, i.e. 'path_html'
5. input_file : the full path of the wiki page
6. css_file : the full path of the css file for this wiki
7. template_path : the full path to the wiki's templates
8. template_default : the default template name
9. template_ext : the extension of template files
10. root_path : a count of ../ for pages buried in subdirs
    if you have wikilink [[dir1/dir2/dir3/my page in a subdir]] then
    %root_path% is replaced by '../../../'.

Options 7-10 are experimental and may change in the future.  If any of these
parameters is empty, then a hyphen &quot;-&quot; is passed to the script in its place.

For an example and further instructions, refer to the following script:

  $VIMHOME/autoload/vimwiki/customwiki2html.sh

An alternative converter was developed by Jason6Anderson, and can
be located at <span class="String"><a href="http://code.google.com/p/vimwiki/issues/detail?id=384">http://code.google.com/p/vimwiki/issues/detail?id=384</a></span>

To use the internal wiki2html converter, use an empty string (the default).

<span class="String">vimwiki-option-list_margin</span>
<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="PreProc">Key               Default value</span>
list_margin       -1

<span class="PreProc">Description</span>
Width of left-hand margin for lists.  When negative, the current <span class="Identifier">shiftwidth</span>
is used.  This affects the behavior of the list manipulation commands
<span class="Identifier">VimwikiListChangeLevel</span> and local mappings <span class="Identifier">vimwiki_gll</span>, <span class="Identifier">vimwiki_glm</span>,
<span class="Identifier">vimwiki_glstar</span>, <span class="Identifier">vimwiki_gl8</span>, <span class="Identifier">vimwiki_gl#</span>, <span class="Identifier">vimwiki_gl3</span>,
<span class="Identifier">vimwiki_gl-</span> and <span class="Identifier">vimwiki_gl1</span>.



<span class="PreProc">------------------------------------------------------------------------------</span>
11.4 Global Options                                   <span class="String">viwmiki-global-options</span>


Global options are configured using the following pattern:

<span class="Comment">    let g:option_name = option_value</span>


<span class="PreProc">-----------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_hl_headers</span>

Highlight headers with =Reddish=, ==Greenish==, ===Blueish=== colors.

<span class="PreProc">Value           Description</span>
1               Use VimwikiHeader1-VimwikiHeader6 group colors to highlight
                different header levels.
0               Use <span class="Identifier">hl-Title</span> color for headers.
Default: 0


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_hl_cb_checked</span>

Checked list items can be highlighted with a color:

<span class="Statement">  </span>* [X] the whole line can be highlighted with the option set to 1.
<span class="Statement">  </span>* [ ] I wish vim could use strikethru.

<span class="PreProc">Value           Description</span>
1               Highlight checked [X] check box with <span class="Identifier">group-name</span> &quot;Comment&quot;.
0               Don't.

Default: 0


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_global_ext</span>

Control the creation of <span class="Identifier">vimwiki-temporary-wiki</span>s.

If a file with a registered extension (see <span class="Identifier">vimwiki-register-extension</span>) is
opened in a directory that is: 1) not listed in <span class="Identifier">g:vimwiki_list</span>, and 2) not a
subdirectory of any such directory, then:

<span class="PreProc">Value           Description</span>
1               make temporary wiki and append it to <span class="Identifier">g:vimwiki_list</span>.
0               don't make temporary wiki in that dir.

If your preferred wiki extension is .txt then you can
<span class="Comment">    let g:vimwiki_global_ext = 0</span>
to restrict vimwiki's operation to only those paths listed in g:vimwiki_list.
Other text files wouldn't be treated as wiki pages.

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_ext2syntax</span> <span class="String">vimwiki-register-extension</span>

A many-to-one map between file extensions and syntaxes whose purpose is to
register the extensions with vimwiki.

E.g.:
<span class="Comment">  let g:vimwiki_ext2syntax = {'.md': 'markdown', </span>
<span class="Comment">                  \ '.mkd': 'markdown',</span>
<span class="Comment">                  \ '.wiki': 'media'}</span>

An extension that is registered with vimwiki can trigger creation of a
<span class="Identifier">vimwiki-temporary-wiki</span> with the associated syntax.  File extensions used in
<span class="Identifier">g:vimwiki_list</span> are automatically registered with vimwiki using the default
syntax.

Default: {}

<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_auto_checkbox</span>

If on, creates checkbox while toggling list item.

<span class="PreProc">Value           Description</span>
0               Do not create checkbox.
1               Create checkbox.

Default: 1

E.g.:
Press <span class="Special">&lt;C-Space&gt;</span> (<span class="Identifier">:VimwikiToggleListItem</span>) on a list item without checkbox to
create it:
<span class="Comment">  * List item</span>
Result:
<span class="Comment">  * [ ] List item</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_menu</span>

GUI menu of available wikies to select.

<span class="PreProc">Value              Description</span>
''                 No menu
'Vimwiki'          Top level menu &quot;Vimwiki&quot;
'Plugin.Vimwiki'   &quot;Vimwiki&quot; submenu of top level menu &quot;Plugin&quot;
etc.

Default: 'Vimwiki'


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_listsyms</span>

String of 5 symbols for list items with checkboxes.
Default value is ' .oOX'.

g:vimwiki_listsyms[0] is for 0% done items.
g:vimwiki_listsyms[4] is for 100% done items.


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_use_mouse</span>

Use local mouse mappings from <span class="Identifier">vimwiki-local-mappings</span>.

<span class="PreProc">Value           Description</span>
0               Do not use mouse mappings.
1               Use mouse mappings.

Default: 0


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_folding</span>

Enable/disable vimwiki's folding (outline) functionality. Folding in vimwiki
can uses either the <span class="Type">'expr'</span> or the <span class="Type">'syntax'</span> <span class="Identifier">foldmethod</span> of Vim.

<span class="PreProc">Value           Description</span>
''              Disable folding.
<span class="Type">'expr'</span>          Folding based on expression (folds sections and code blocks).
<span class="Type">'syntax'</span>        Folding based on syntax (folds sections; slower than <span class="Type">'expr'</span>).
<span class="Type">'list'</span>          Folding based on expression (folds list subitems; much slower).

Default: ''

Limitations:
  - Opening very large files may be slow when folding is enabled.
  - <span class="Type">'list'</span> folding is particularly slow with larger files.
  - <span class="Type">'list'</span> is intended to work with lists nicely indented with <span class="Type">'shiftwidth'</span>.
  - <span class="Type">'syntax'</span> is only available for the default syntax so far.


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_list_ignore_newline</span>

This is HTML related.
Convert newlines to &lt;br /&gt;s in multiline list items.

<span class="PreProc">Value           Description</span>
0               Newlines in a list item are converted to &lt;br /&gt;s.
1               Ignore newlines.

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_use_calendar</span>

Create new or open existing diary wiki-file for the date selected in Calendar.
See <span class="Identifier">vimwiki-calendar</span>.

<span class="PreProc">Value           Description</span>
0               Do not use calendar.
1               Use calendar.

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">VimwikiLinkHandler</span>

A customizable link handler, <span class="Identifier">VimwikiLinkHandler</span>, can be defined to override
Vimwiki's opening of links.  Each recognized link, whether it is a wikilink,
wiki-include link or a weblink, is first passed to <span class="Identifier">VimwikiLinkHandler</span> to see
if it can be handled.  The return value 1/0 indicates success.

If the link is not handled successfully, the behaviour of Vimwiki depends on
the scheme.  Wiki:, diary: or schemeless links are opened in Vim.  All others,
including local: and file: schemes, are opened with a system default handler;
i.e. Linux (!xdg-open), Mac (!open), and Windows (!start).

You can redefine <span class="Identifier">VimwikiLinkHandler</span> function to do something else:

<span class="Comment">  function! VimwikiLinkHandler(link) </span>
<span class="Comment">    try</span>
<span class="Comment">      let browser = 'C:\Program Files\Firefox\firefox.exe'</span>
<span class="Comment">      execute '!start &quot;'.browser.'&quot; ' . a:link</span>
<span class="Comment">      return 1</span>
<span class="Comment">    catch</span>
<span class="Comment">      echo &quot;This can happen for a variety of reasons ...&quot;</span>
<span class="Comment">    endtry</span>
<span class="Comment">    return 0</span>
<span class="Comment">  endfunction </span>

A second example handles two new schemes, 'vlocal:' and 'vfile:', which behave
similar to 'local:' and 'file:' schemes, but are always opened with Vim&#0058;

<span class="Comment">  function! VimwikiLinkHandler(link) &quot;{{{ Use Vim to open links with the</span>
<span class="Comment">    &quot; 'vlocal:' or 'vfile:' schemes.  E.g.:</span>
<span class="Comment">    &quot;   1) [[vfile:///~/Code/PythonProject/abc123.py]], and</span>
<span class="Comment">    &quot;   2) [[vlocal:./|Wiki Home]]</span>
<span class="Comment">    let link = a:link</span>
<span class="Comment">    if link =~ &quot;vlocal:&quot; || link =~ &quot;vfile:&quot;</span>
<span class="Comment">      let link = link[1:]</span>
<span class="Comment">    else</span>
<span class="Comment">      return 0</span>
<span class="Comment">    endif</span>
<span class="Comment">    let [idx, scheme, path, subdir, lnk, ext, url] = </span>
<span class="Comment">         \ vimwiki#base#resolve_scheme(link, 0)</span>
<span class="Comment">    if g:vimwiki_debug</span>
<span class="Comment">      echom 'LinkHandler: idx='.idx.', scheme=[v]'.scheme.', path='.path.</span>
<span class="Comment">           \ ', subdir='.subdir.', lnk='.lnk.', ext='.ext.', url='.url</span>
<span class="Comment">    endif</span>
<span class="Comment">    if url == ''</span>
<span class="Comment">      echom 'Vimwiki Error: Unable to resolve link!'</span>
<span class="Comment">      return 0</span>
<span class="Comment">    else</span>
<span class="Comment">      call vimwiki#base#edit_file('tabnew', url, [], 0)</span>
<span class="Comment">      return 1</span>
<span class="Comment">    endif</span>
<span class="Comment">  endfunction &quot; }}}</span>


<span class="PreProc">-----------------------------------------------------------------------------</span>
<span class="PreProc">*VimwikiWikiIncludeHandler*</span>

Vimwiki includes the contents of a wiki-include URL as an image by default.

A trial feature allows you to supply your own handler for wiki-include links.
The handler should return the empty string when it does not recognize or
cannot otherwise convert the link.  A customized handler might look like this:

<span class="Comment">  &quot; Convert {{URL|#|ID}} -&gt; URL#ID</span>
<span class="Comment">  function! VimwikiWikiIncludeHandler(value) &quot;{{{</span>
<span class="Comment">    let str = a:value</span>

<span class="Comment">    &quot; complete URL</span>
<span class="Comment">    let url_0 = matchstr(str, g:vimwiki_rxWikiInclMatchUrl)</span>
<span class="Comment">    &quot; URL parts</span>
<span class="Comment">    let [scheme, path, subdir, lnk, ext, url] = </span>
<span class="Comment">          \ vimwiki#base#resolve_scheme(url_0, VimwikiGet('ext'))</span>
<span class="Comment">    let arg1 = matchstr(str, VimwikiWikiInclMatchArg(1))</span>
<span class="Comment">    let arg2 = matchstr(str, VimwikiWikiInclMatchArg(2))</span>

<span class="Comment">    if arg1 =~ '#'</span>
<span class="Comment">      return url.'#'.arg2</span>
<span class="Comment">    endif</span>

<span class="Comment">    &quot; Return the empty string when unable to process link</span>
<span class="Comment">    return ''</span>
<span class="Comment">  endfunction &quot;}}}</span>


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_table_mappings</span>

Enable/disable table mappings for INSERT mode.

<span class="PreProc">Value           Description</span>
0               Disable table mappings.
1               Enable table mappings.

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_table_auto_fmt</span>

Enable/disable table auto formatting after leaving INSERT mode.

<span class="PreProc">Value           Description</span>
0               Disable table auto formatting.
1               Enable table auto formatting.

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_w32_dir_enc</span>

Convert directory name from current <span class="Identifier">encoding</span> into 'g:vimwiki_w32_dir_enc'
before it is created.

If you have 'enc=utf-8' and set up
<span class="Comment">    let g:vimwiki_w32_dir_enc = 'cp1251'</span>

then following the next link with <span class="Special">&lt;CR&gt;</span>:
<span class="Comment">    [[привет/мир]]</span>

would convert utf-8 'привет' to cp1251 and create directory with that name.

Default: ''


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_CJK_length</span>

Use special method to calculate correct length of the strings with double-wide
characters (to align table cells properly).

<span class="PreProc">Value           Description</span>
0               Do not use it.
1               Use it.

Default: 0

<span class="Todo">Note</span>: Vim73 has a new function <span class="Identifier">strdisplaywidth</span>, so for Vim73 users this
option is obsolete.


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_dir_link</span>

This option is about what to do with links to directories -- [[directory/]],
[[papers/]], etc.

<span class="PreProc">Value           Description</span>
''              Open 'directory/' using standard netrw plugin.
<span class="Type">'index'</span>         Open 'directory/index.wiki', create if needed.
<span class="Type">'main'</span>          Open 'directory/main.wiki', create if needed.
etc.

Default: '' (empty string)


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_html_header_numbering</span>

Set this option if you want headers to be auto-numbered in HTML.

E.g.:
<span class="Comment">    1 Header1</span>
<span class="Comment">    1.1 Header2</span>
<span class="Comment">    1.2 Header2</span>
<span class="Comment">    1.2.1 Header3</span>
<span class="Comment">    1.2.2 Header3</span>
<span class="Comment">    1.3 Header2</span>
<span class="Comment">    2 Header1</span>
<span class="Comment">    3 Header1</span>
etc.

<span class="PreProc">Value           Description</span>
0               Header numbering is off.
1               Header numbering is on. Headers are numbered starting from
                header level 1.
2               Header numbering is on. Headers are numbered starting from
                header level 2.
etc.
Example when g:vimwiki_html_header_numbering = 2:
<span class="Comment">    Header1</span>
<span class="Comment">    1 Header2</span>
<span class="Comment">    2 Header2</span>
<span class="Comment">    2.1 Header3</span>
<span class="Comment">    2.1.1 Header4</span>
<span class="Comment">    2.1.2 Header4</span>
<span class="Comment">    2.2 Header3</span>
<span class="Comment">    3 Header2</span>
<span class="Comment">    4 Header2</span>
etc.

Default: 0


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_html_header_numbering_sym</span>

Ending symbol for <span class="Identifier">g:vimwiki_html_header_numbering</span>.

<span class="PreProc">Value           Description</span>
'.'             Dot will be added after a header's number.
')'             Closing bracket will be added after a header's number.
etc.

With
    let g:vimwiki_html_header_numbering_sym = '.'
headers would look like:
<span class="Comment">    1. Header1</span>
<span class="Comment">    1.1. Header2</span>
<span class="Comment">    1.2. Header2</span>
<span class="Comment">    1.2.1. Header3</span>
<span class="Comment">    1.2.2. Header3</span>
<span class="Comment">    1.3. Header2</span>
<span class="Comment">    2. Header1</span>
<span class="Comment">    3. Header1</span>


Default: '' (empty)


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_valid_html_tags</span>

Case-insensitive comma separated list of HTML tags that can be used in vimwiki.

Default: 'b,i,s,u,sub,sup,kbd,br,hr'


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_user_htmls</span>

Comma-separated list of HTML files that have no corresponding wiki files and
should not be deleted after <span class="Identifier">:VimwikiAll2HTML</span>.

Default: ''

Example:
Consider you have 404.html and search.html in your vimwiki 'path_html'.
With:
<span class="Comment">    let g:vimwiki_user_htmls = '404.html,search.html'</span>
they would not be deleted after <span class="Identifier">:VimwikiAll2HTML</span>.


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_conceallevel</span>

In vim73 <span class="Identifier">conceallevel</span> is local to window, thus if you open viwmiki buffer in
a new tab or window, it would be set to default value.

Vimwiki sets <span class="Identifier">conceallevel</span> to g:vimwiki_conceallevel everytime vimwiki buffer
is entered.

With default settings, Vimwiki conceals one-character markers, shortens long
URLs and hides markers and URL for links that have a description.

Default: 2


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_autowriteall</span>

In vim <span class="Identifier">autowriteall</span> is a global setting. With g:vimwiki_autowriteall vimwiki
makes it local to its buffers.

<span class="PreProc">Value           Description</span>
0               autowriteall is off
1               autowriteall is on

Default: 1


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_url_maxsave</span>

Setting the value of <span class="Identifier">g:vimwiki_url_maxsave</span> to 0 will prevent any link
shortening: you will see the full URL in all types of links, with no parts
being concealed. Concealing of one-character markers is not affected.

When positive, the value determines the maximum number of characters that
are retained at the end after concealing the middle part of a long URL.
It could be less: in case one of the characters /,#,? is found near the end,
the URL will be concealed up to the last occurrence of that character.

<span class="Todo">Note</span>:
<span class="Statement">  </span>* The conceal feature works only with Vim &gt;= 7.3.
<span class="Statement">  </span>* When using the default <span class="Identifier">wrap</span> option of Vim, the effect of concealed links
    is not always pleasing, because the visible text on longer lines with
    a lot of concealed parts may appear to be strangely broken across several
    lines. This is a limitation of Vim's <span class="Identifier">conceal</span> feature.
<span class="Statement">  </span>* Many color schemes do not define an unobtrusive color for the Conceal
    highlight group - this might be quite noticeable on shortened URLs.


Default: 15


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_debug</span>

Controls verbosity of debugging output, for example, the diagnostic
information about HTML conversion.

<span class="PreProc">Value           Description</span>
0               Do not show debug messages.
1               Show debug messages.

Default: 0


<span class="PreProc">------------------------------------------------------------------------------</span>
<span class="String">g:vimwiki_diary_months</span>

It is a <span class="Identifier">Dictionary</span> with the numbers of months and corresponding names. Diary
uses it.

Redefine it in your .vimrc to get localized months in your diary:
let g:vimwiki_diary_months = {
      \ 1: 'Январь', 2: 'Февраль', 3: 'Март',
      \ 4: 'Апрель', 5: 'Май', 6: 'Июнь',
      \ 7: 'Июль', 8: 'Август', 9: 'Сентябрь',
      \ 10: 'Октябрь', 11: 'Ноябрь', 12: 'Декабрь'
      \ }

Default:
let g:vimwiki_diary_months = {
      \ 1: 'January', 2: 'February', 3: 'March',
      \ 4: 'April', 5: 'May', 6: 'June',
      \ 7: 'July', 8: 'August', 9: 'September',
      \ 10: 'October', 11: 'November', 12: 'December'
      \ }


<span class="PreProc">==============================================================================</span>
12. Help                                                        <span class="String">vimwiki-help</span>

Your help in making vimwiki better is really appreciated!
Any help, whether it is a spelling correction or a code snippet to patch --
everything is welcomed.

Issues can be filed at <span class="String"><a href="http://code.google.com/p/vimwiki/issues">http://code.google.com/p/vimwiki/issues</a></span> .


<span class="PreProc">==============================================================================</span>
13. Developers                                            <span class="String">vimwiki-developers</span>

    - Maxim Kim &lt;habamax@gmail.com&gt; as original author.
    - Stuart Andrews
    - Tomas Pospichal
    - See the <span class="String"><a href="http://code.google.com/p/vimwiki/people/list">http://code.google.com/p/vimwiki/people/list</a></span> for the others.

Web: <span class="String"><a href="http://code.google.com/p/vimwiki/">http://code.google.com/p/vimwiki/</a></span>
Mail-List: <span class="String"><a href="https://groups.google.com/forum/#!forum/vimwiki">https://groups.google.com/forum/#!forum/vimwiki</a></span>
Vim plugins: <span class="String"><a href="http://www.vim.org/scripts/script.php?script_id=2226">http://www.vim.org/scripts/script.php?script_id=2226</a></span>


<span class="PreProc">==============================================================================</span>
14. Changelog                                              <span class="String">vimwiki-changelog</span>

<span class="PreProc">2.1</span>

<span class="Statement">    </span>* Concealing of links can be turned off - set <span class="Identifier">g:vimwiki_url_maxsave</span> to 0.
      The option g:vimwiki_url_mingain was removed
<span class="Statement">    </span>* <span class="Identifier">g:vimwiki_folding</span> also accepts value <span class="Type">'list'</span>; with <span class="Type">'expr'</span> both sections
      and code blocks folded, g:vimwiki_fold_lists option was removed
<span class="Statement">    </span>* Issue 261: Syntax folding is back. <span class="Identifier">g:vimwiki_folding</span> values are
      changed to '', <span class="Type">'expr'</span>, <span class="Type">'syntax'</span>.
<span class="Statement">    </span>* Issue 372: Ignore case in g:vimwiki_valid_html_tags
<span class="Statement">    </span>* Issue 374: Make autowriteall local to vimwiki. It is not 100% local
      though.
<span class="Statement">    </span>* Issue 384: Custom_wiki2html script now receives templating arguments
<span class="Statement">    </span>* Issue 393: Custom_wiki2html script path can contain tilde character
<span class="Statement">    </span>* Issue 392: Custom_wiki2html arguments are quoted, e.g names with spaces
<span class="Statement">    </span>* Various small bug fixes.

<span class="PreProc">2.0.1 'stu'</span>

<span class="Statement">    </span>* Follow (i.e. open target of) markdown reference-style links.
<span class="Statement">    </span>* Bug fixes.


<span class="PreProc">2.0 'stu'</span>

This release is partly incompatible with previous.

<span class="PreProc">Summary</span>

<span class="Statement">    </span>* Quick page-link creation.
<span class="Statement">    </span>* Redesign of link syntaxes (!)
<span class="Statement">        </span>* No more CamelCase links. Check the ways to convert them
          <span class="String"><a href="https://groups.google.com/forum/?fromgroups#!topic/vimwiki/NdS9OBG2dys">https://groups.google.com/forum/?fromgroups#!topic/vimwiki/NdS9OBG2dys</a></span>
<span class="Statement">        </span>* No more [[link][desc]] links.
<span class="Statement">        </span>* No more [<span class="String"><a href="http://link">http://link</a></span> description] links.
<span class="Statement">        </span>* No more plain image links. Use transclusions.
<span class="Statement">        </span>* No more image links identified by extension. Use transclusions.
<span class="Statement">    </span>* Interwiki links. See <span class="Identifier">vimwiki-syntax-schemes</span>.
<span class="Statement">    </span>* Link schemes. See <span class="Identifier">vimwiki-syntax-schemes</span>.
<span class="Statement">    </span>* Transclusions. See <span class="Identifier">vimwiki-syntax-transclude</span>.
<span class="Statement">    </span>* Normalize link command. See <span class="Identifier">vimwiki_+</span>.
<span class="Statement">    </span>* Improved diary organization and generation. See <span class="Identifier">vimwiki-diary</span>.
<span class="Statement">    </span>* List manipulation. See <span class="Identifier">vimwiki-list-manipulation</span>.
<span class="Statement">    </span>* Markdown support.
<span class="Statement">    </span>* Mathjax support. See <span class="Identifier">vimwiki-syntax-math</span>.
<span class="Statement">    </span>* Improved handling of special characters and punctuation in filenames and
      urls.
<span class="Statement">    </span>* Back links command: list links referring to the current page.
<span class="Statement">    </span>* Highlighting nonexisted links are off by default.
<span class="Statement">    </span>* Table syntax change. Row separator uses | instead of +.
<span class="Statement">    </span>* Fold multilined list items.
<span class="Statement">    </span>* Custom wiki to HTML converters. See <span class="Identifier">vimwiki-option-custom_wiki2html</span>.
<span class="Statement">    </span>* Conceal long weblinks. See g:vimwiki_url_mingain.
<span class="Statement">    </span>* Option to disable table mappings. See <span class="Identifier">g:vimwiki_table_mappings</span>.

For detailed information see issues list on
<span class="String"><a href="http://code.google.com/p/vimwiki/issues/list">http://code.google.com/p/vimwiki/issues/list</a></span>


<span class="PreProc">1.2</span>
<span class="Statement">    </span>* Issue 70: Table spanning cell support.
<span class="Statement">    </span>* Issue 72: Do not convert again for unchanged file. <span class="Identifier">:VimwikiAll2HTML</span>
      converts only changed wiki files.
<span class="Statement">    </span>* Issue 117: <span class="Identifier">VimwikiDiaryIndex</span> command that opens diary index wiki page.
<span class="Statement">    </span>* Issue 120: Links in headers are not highlighted in vimwiki but are
      highlighted in HTML.
<span class="Statement">    </span>* Issue 138: Added possibility to remap table-column move bindings. See
      <span class="Identifier">:VimwikiTableMoveColumnLeft</span> and <span class="Identifier">:VimwikiTableMoveColumnRight</span>
      commands. For remap instructions see <span class="Identifier">vimwiki_&lt;A-Left&gt;</span>
      and <span class="Identifier">vimwiki_&lt;A-Right&gt;</span>.
<span class="Statement">    </span>* Issue 125: Problem with 'o' command given while at the of the file.
<span class="Statement">    </span>* Issue 131: FileType is not set up when GUIEnter autocommand is used in
      vimrc. Use <span class="Type">'nested'</span> in 'au GUIEnter * nested VimwikiIndex'
<span class="Statement">    </span>* Issue 132: Link to perl (or any non-wiki) file in vimwiki subdirectory
      doesn't work as intended.
<span class="Statement">    </span>* Issue 135: %title and %toc used together cause TOC to appear in an
      unexpected place in HTML.
<span class="Statement">    </span>* Issue 139: <span class="Identifier">:VimwikiTabnewLink</span> command is added.
<span class="Statement">    </span>* Fix of g:vimwiki_stripsym = '' (i.e. an empty string) -- it removes bad
      symbols from filenames.
<span class="Statement">    </span>* Issue 145: With modeline 'set ft=vimwiki' links are not correctly
      highlighted when open wiki files.
<span class="Statement">    </span>* Issue 146: Filetype difficulty with &quot;.txt&quot; as a vimwiki extension.
<span class="Statement">    </span>* Issue 148: There are no mailto links.
<span class="Statement">    </span>* Issue 151: Use location list instead of quickfix list for :VimwikiSearch
      command result. Use :lopen instead of :copen, :lnext instead of :cnext
      etc.
<span class="Statement">    </span>* Issue 152: Add the list of HTML files that would not be deleted after
      <span class="Identifier">:VimwikiAll2HTML</span>.
<span class="Statement">    </span>* Issue 153: Delete HTML files that has no corresponding wiki ones with
      <span class="Identifier">:VimwikiAll2HTML</span>.
<span class="Statement">    </span>* Issue 156: Add multiple HTML templates. See
      <span class="Identifier">vimwiki-option-template_path</span>. Options html_header and html_footer are
      no longer exist.
<span class="Statement">    </span>* Issue 173: When virtualedit=all option is enabled the 'o' command behave
      strange.
<span class="Statement">    </span>* Issue 178: Problem with alike wikie's paths.
<span class="Statement">    </span>* Issue 182: Browser command does not quote url.
<span class="Statement">    </span>* Issue 183: Spelling error highlighting is not possible with nested
      syntaxes.
<span class="Statement">    </span>* Issue 184: Wrong foldlevel in some cases.
<span class="Statement">    </span>* Issue 195: Page renaming issue.
<span class="Statement">    </span>* Issue 196: vim&#0058; modeline bug -- syn=vim doesn't work.
<span class="Statement">    </span>* Issue 199: Generated HTML for sublists is invalid.
<span class="Statement">    </span>* Issue 200: Generated HTML for todo lists does not show completion status
      the fix relies on CSS, thus your old stylesheets need to be updated!;
      may not work in obsolete browsers or font-deficient systems.
<span class="Statement">    </span>* Issue 205: Block code: highlighting differs from processing. Inline code
      block {{{ ... }}} is removed. Use <span class="Comment">...</span> instead.
<span class="Statement">    </span>* Issue 208: Default highlight colors are problematic in many
      colorschemes. Headers are highlighted as <span class="Identifier">hl-Title</span> by default, use
      <span class="Identifier">g:vimwiki_hl_headers</span> to restore previous default Red, Green, Blue or
      custom header colors. Some other changes in highlighting.
<span class="Statement">    </span>* Issue 209: Wild comments slow down html generation. Comments are
      changed, use %% to comment out entire line.
<span class="Statement">    </span>* Issue 210: HTML: para enclose header.
<span class="Statement">    </span>* Issue 214: External links containing Chinese characters get trimmed.
<span class="Statement">    </span>* Issue 218: Command to generate HTML file and open it in webbrowser. See
      <span class="Identifier">:Vimwiki2HTMLBrowse</span>(bind to <span class="Special">&lt;leader&gt;</span>whh)
<span class="Statement">    </span>* NEW: Added <span class="Special">&lt;Leader&gt;</span>wh mapping to call <span class="Identifier">:Vimwiki2HTML</span>


...

39 releases

...

<span class="PreProc">0.1</span>
<span class="Statement">    </span>* First public version.

<span class="PreProc">==============================================================================</span>
15. License                                                  <span class="String">vimwiki-license</span>

The MIT Licence
<span class="String"><a href="http://www.opensource.org/licenses/mit-license.php">http://www.opensource.org/licenses/mit-license.php</a></span>

Copyright (c) 2008-2010 Maxim Kim

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the &quot;Software&quot;), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.



 vim&#0058;tw=78:ts=8:ft=help
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
